Skip to content

Adds CLI notes from recent team walk-throughs and discussions - #2392

Merged
Su (sushmangupta) merged 21 commits into
mainfrom
docs-adds-cli-jul22
Jul 28, 2026
Merged

Adds CLI notes from recent team walk-throughs and discussions#2392
Su (sushmangupta) merged 21 commits into
mainfrom
docs-adds-cli-jul22

Conversation

@lasomethingsomething

@lasomethingsomething somethings (lasomethingsomething) commented Jul 23, 2026

Copy link
Copy Markdown
Contributor

Summary

Adds mostly small snippets of context across the CLI pages.

Related links

Checklist

  • I reviewed affected links, code samples, and cross-references, including PageRef references where relevant.
  • I added or updated redirects in .gitbook.yaml if pages were moved, renamed, or deleted.
  • I updated .wordlist.txt (and sorted it) if spellcheck flags new legitimate terms.
  • Any required dependent changes in downstream modules have already been merged and published.
  • This pull request is ready for review.

Notes

Copilot AI review requested due to automatic review settings July 23, 2026 08:13
@shopware-dev-docs-connector

shopware-dev-docs-connector Bot commented Jul 23, 2026

Copy link
Copy Markdown

Developer Docs healthcheck

Status: Completed with success.
Repository: shopware/docs
Commit: 3841d1d
Preview: https://developer-documentation-8rkbyafki-shopware-frontends.vercel.app
Workflow run: #4613

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds additional operational context and usage notes across the Shopware CLI documentation pages to help readers understand common workflows (validation, store publishing, project tooling) and when to use particular commands.

Changes:

  • Expanded CLI command explanations with more “why/when” context (validation, image proxy, anonymized dumps, project build/CI, refactoring).
  • Added new practical notes and warnings for Store/Account workflows (local metadata management, “goes live immediately” warning, logout).
  • Documented additional related commands and schema helpers (extension/project config schema, get-name, activate/deactivate).

Reviewed changes

Copilot reviewed 16 out of 16 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
products/tools/cli/validation.md Adds more detailed explanation of what validation does and why to test lowest/highest constraints.
products/tools/cli/shopware-account-commands/updating-store-page.md Adds guidance on tracking Store metadata in Git and warns about immediate visibility of pushes.
products/tools/cli/shopware-account-commands/releasing-extension-to-shopware-store.md Clarifies upload workflow steps and CI/CD-oriented usage.
products/tools/cli/shopware-account-commands/configure-composer-repository.md Reworks guidance around Composer/Store authentication (noted issues in review).
products/tools/cli/shopware-account-commands/authentication.md Adds logout instructions and an additional producer listing command.
products/tools/cli/project-commands/remote-extension-management.md Expands overview and adds activate/deactivate commands.
products/tools/cli/project-commands/mysql-dump.md Adds anonymization rationale, usage example, and updates config file reference.
products/tools/cli/project-commands/image-proxy.md Adds problem statement and clearer behavior description; improves usage note.
products/tools/cli/project-commands/helper-commands.md Adds notes about --no-audit, admin build/watch behavior, worker usage, and project utilities (noted issue in review).
products/tools/cli/project-commands/build.md Adds “most-used command” context, CI platform flag overview, and SBOM explanation.
products/tools/cli/project-commands/autofix.md Clarifies version context for Symfony Flex migration and improves Composer migration section.
products/tools/cli/index.md Adds telemetry overview and links to telemetry reference.
products/tools/cli/extension-commands/extract-meta-data.md Adds get-name and extension config schema command documentation.
products/tools/cli/extension-commands/configuration.md Mentions schema extraction command for .shopware-extension.yml.
products/tools/cli/extension-commands/build.md Adds esbuild-related asset hashing/Vite manifest notes and expands release-mode explanation (noted issue in review).
products/tools/cli/automatic-refactoring.md Expands motivation and adds options examples for project fix.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread products/tools/cli/project-commands/helper-commands.md Outdated
Comment thread products/tools/cli/extension-commands/build.md Outdated
Comment thread products/tools/cli/shopware-account-commands/configure-composer-repository.md Outdated
Comment thread products/tools/cli/validation.md Outdated
@Isengo1989 Micha Hobert (Isengo1989) added the Improvement PR created to append/modify info in the existing article label Jul 24, 2026
@lasomethingsomething

Copy link
Copy Markdown
Contributor Author

Soner (@shyim) I just updated references to extension zip with extension package (changes are on the build.md CLI page).

Comment thread products/tools/cli/extension-commands/build.md Outdated
Comment thread products/tools/cli/project-commands/build.md Outdated
@lasomethingsomething

Copy link
Copy Markdown
Contributor Author

@copilot resolve the merge conflicts in this pull request

Copilot AI commented Jul 27, 2026

Copy link
Copy Markdown
Contributor

Copilot resolve the merge conflicts in this pull request

Merge conflicts have been resolved in commit eb438a0 (merge of main into docs-adds-cli-jul22). All CI checks are passing.

@shyim

Copy link
Copy Markdown
Member

Copilot resolve the merge conflicts in this pull request

Copilot AI commented Jul 28, 2026

Copy link
Copy Markdown
Contributor

Copilot resolve the merge conflicts in this pull request

Merge conflicts resolved in commit db583beb. The conflict was a modify/delete conflict on configure-composer-repository.md — since main deleted it via #2396, I've accepted that deletion in this branch too.

@lasomethingsomething

Copy link
Copy Markdown
Contributor Author

Heya Su (@sushmangupta) Micha Hobert (@Isengo1989) Bojan Rajh (@bojanrajh) Methinks this can be merged now

@sushmangupta
Su (sushmangupta) merged commit 52a996b into main Jul 28, 2026
9 checks passed
@sushmangupta
Su (sushmangupta) deleted the docs-adds-cli-jul22 branch July 28, 2026 13:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Improvement PR created to append/modify info in the existing article

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants